Download OpenAPI specification:
MarlinDT Network Intelligence provides analytical and prediction insights for telecommunications infrastructure and services.
{- "providers": {
- "email": 1,
- "kafka": 1,
- "map": 1,
- "workflow": 1
}, - "alerts": {
- "available": 4,
- "active": {
- "callbacks": 0,
- "publish": 0,
- "notify": 0,
- "workflow": 0
}
}, - "queues": {
- "predict": {
- "pending": 0,
- "completed": 17
}
}, - "resources": {
- "cables": {
- "total": 1,
- "active": 1,
- "inactive": 0
}, - "ducts": {
- "total": 1,
- "active": 1,
- "inactive": 0
}, - "nes": {
- "total": 0,
- "active": 0,
- "inactive": 0
}, - "poles": {
- "total": 2,
- "active": 2,
- "inactive": 0
}, - "services": {
- "total": 0,
- "active": 0,
- "inactive": 0
}, - "sites": {
- "total": 0,
- "active": 0,
- "inactive": 0
}, - "trenches": {
- "total": 1,
- "active": 1,
- "inactive": 0
}
}
}{- "vendor": "Google Maps",
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
[- "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "3e8c816b-499d-4809-bc97-3f17d3fff2a5",
- "6d3bd8bd-093f-4f17-b391-5f4f83984a97",
- "6aa7845b-e6fa-4668-a0cc-45d5b46fa4cc",
- "aee8b41f-97ab-4e35-88c7-b40391dca6f7",
- "438463bc-9f9f-4410-b937-2d3acd04b24e",
- "16bbab26-545e-4ece-b55c-015a34f19847",
- "ebbb4134-f0fd-4c9f-99bf-c994ddc15890",
- "370a5524-781c-4f5f-b47d-c498c3f60839"
]| description required | string |
| delete required | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
| function required | string Default: "noop();" |
{- "description": "Switching/Routing Classifiers",
- "delete": false,
- "function": "noop();"
}{- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7"
}| alertId required | string <uuid> internal alert identifier |
| description | string |
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
| function | string Default: "noop();" |
{- "function": "jobAlertNePortUtil75();"
}{ }| alertContentId required | string <uuid> internal alert content identifier |
{- "alertContentId": "35c94368-5c16-4689-b506-8b1b952077ec",
- "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
- "point": "stringstringstr",
- "content": "string"
}| alertId required | string <uuid> (alertId) internal alert identifier |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| content required | string non-empty |
{- "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
- "point": "stringstringstr",
- "content": "string"
}{- "alertContentId": "e60f9712-dda3-4537-9538-17e96e87bd0d"
}| cveId required | stringCVE-[0-9]{4}-[0-9]{4} external CVE identifier |
{- "cveId": "CVE-2025-5516",
- "published": "20250516T181900",
- "vendor": "Merkator nv/sa",
- "uri": "2025/5xxx/CVE-2025-5516.json",
- "platforms": [
- "MNI"
], - "versions": [
- {
- "lessThan": "1.0",
- "status": "affected",
- "version": "0",
- "versionType": "semver"
}
]
}| cveId required | string (cveId) CVE-[0-9]{4}-[0-9]{4,} external CVE identifier |
| published required | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| unpdated | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| vendor required | string |
| uri required | string <url> |
| platforms required | Array of strings non-empty |
required | Array of objects non-empty |
{- "cveId": "CVE-2025-5516",
- "published": "20250516T181900",
- "vendor": "Merkator nv/sa",
- "uri": "2025/5xxx/CVE-2025-5516.json",
- "platforms": [
- "MNI"
], - "versions": [
- {
- "lessThan": "1.0",
- "status": "affected",
- "version": "0",
- "versionType": "semver"
}
]
}{- "cveId": "CVE-2025-5516"
}| requestorId required | string <uuid> (requestorId) unique identifier of the requesting originator |
required | Array of objects non-empty |
{- "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
- "alerts": [
- {
- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "username": "internal",
- "password": "service",
- "authentication": "basic",
- "retries": 3,
- "retryDelay": 180,
- "maxLifeRetries": 24
}
]
}{- "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
- "alerts": [
- {
- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "subscriptionId": "3ffc8917-f24d-4d6d-9665-83ecaf05feee"
}
]
}{- "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
- "content": { }
}| requestorId required | string <uuid> unique identifier of the requesting originator |
| subscriptionId required | Array of strings <uuid> [ items <uuid > ] one or more unique subscription identifiers to unsubscribe from, serialized as |
{ }| requestorId required | string <uuid> (requestorId) unique identifier of the requesting originator |
required | Array of objects non-empty |
{- "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
- "alerts": [
- {
- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "kafkaProducerId": "5b1ef698-1cf3-4f12-a671-d60ff283db41",
- "topic": "mni-L23-classifiers"
}
]
}{- "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
- "alerts": [
- {
- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "publicationId": "3ffc8917-f24d-4d6d-9665-83ecaf05feee"
}
]
}| requestorId required | string <uuid> unique identifier of the requesting originator |
| publicationId required | Array of strings <uuid> [ items <uuid > ] one or more unique publishing identifiers to unpublish from, serialized as |
{ }| notificationId required | string <uuid> single alert notifying identifier |
{- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad",
- "subject": "mni-L23-classifiers alert",
- "recipients": [
- "engineer@telsdn.net"
]
}| requestorId required | string <uuid> (requestorId) unique identifier of the requesting originator |
required | Array of objects non-empty |
{- "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
- "alerts": [
- {
- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad",
- "subject": "mni-L23-classifiers alert",
- "recipients": [
- "engineer@telsdn.net"
]
}
]
}{- "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
- "alerts": [
- {
- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "notificationId": "3ffc8917-f24d-4d6d-9665-83ecaf05feee"
}
]
}| requestorId required | string <uuid> unique identifier of the requesting originator |
| notificationId required | Array of strings <uuid> [ items <uuid > ] one or more unique notifying identifiers to cease, serialized as |
{ }| requestorId required | string <uuid> unique identifier of the requesting originator |
required | Array of objects non-empty |
{- "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
- "alerts": [
- {
- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "workflowEngineId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad",
- "flowName": "BandwidthConsumptionA2B"
}
]
}{- "requestorId": "7c48ef5f-3499-4daf-be2c-82d2b487d869",
- "alerts": [
- {
- "alertId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "workflowRunnerId": "3ffc8917-f24d-4d6d-9665-83ecaf05feee"
}
]
}| requestorId required | string <uuid> unique identifier of the requesting originator |
| workflowRunnerId required | Array of strings <uuid> [ items <uuid > ] one or more unique workflow runner identifiers to cease, serialized as |
{ }{- "qId": 1,
- "point": "20250603T181900",
- "type": "callback",
- "id": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7",
- "callback": "3ffc8917-f24d-4d6d-9665-83ecaf05feee"
}[- {
- "technology": "copper",
- "unit": "m",
- "costPerUnit": 1
}, - {
- "technology": "ethernet",
- "unit": "m",
- "costPerUnit": 1
}, - {
- "technology": "singleFiber",
- "unit": "m",
- "costPerUnit": 1
}, - {
- "technology": "multiFiber",
- "unit": "m",
- "costPerUnit": 1
}
]| technology required | string (cableTechnology) Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber" technology domain of cable |
| unit required | string (sizeUnit) Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet" unit of measure of the dimension:
|
| costPerUnit required | number <currency> >= 0 |
{- "technology": "coax",
- "unit": "m",
- "costPerUnit": 1
}{ }| technology required | string (cableTechnology) Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber" technology domain of cable |
| unit required | string (sizeUnit) Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet" unit of measure of the dimension:
|
| costPerUnit required | number <currency> >= 0 |
{- "technology": "singleFiber",
- "unit": "m",
- "costPerUnit": 1.5
}{ }| technology required | string (cableTechnology) Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber" technology domain of cable |
{- "technology": "coax"
}{ }[- {
- "category": "duct",
- "configuration": 1,
- "unit": "m",
- "costPerUnit": 1
}, - {
- "category": "microduct",
- "configuration": 19,
- "unit": "m",
- "costPerUnit": 2
}, - {
- "category": "subduct",
- "configuration": 2,
- "unit": "m",
- "costPerUnit": 1.25
}
]| category required | string (ductSizeCategory) Enum: "duct" "subduct" size classification of the duct |
| configuration required | integer (ductConfiguration) [ 1 .. 48 ] 1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle |
| unit required | string (sizeUnit) Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet" unit of measure of the dimension:
|
| costPerUnit required | number <currency> >= 0 |
{- "category": "duct",
- "configuration": 24,
- "unit": "m",
- "costPerUnit": 2
}{ }| category required | string (ductSizeCategory) Enum: "duct" "subduct" size classification of the duct |
| configuration required | integer (ductConfiguration) [ 1 .. 48 ] 1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle |
| unit required | string (sizeUnit) Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet" unit of measure of the dimension:
|
| costPerUnit required | number <currency> >= 0 |
{- "category": "duct",
- "configuration": 12,
- "unit": "m",
- "costPerUnit": 1.1
}{ }| category required | string (ductSizeCategory) Enum: "duct" "subduct" size classification of the duct |
| configuration required | integer (ductConfiguration) [ 1 .. 48 ] 1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle |
{- "category": "duct",
- "configuration": 19
}{ }| vendor required | string |
| model required | string |
| costPerUnit required | number <currency> >= 0 |
{- "vendor": "Juniper Networks",
- "model": "MX250",
- "costPerUnit": 32768
}{ }| vendor required | string |
| model required | string |
| costPerUnit required | number <currency> >= 0 |
{- "vendor": "Juniper Networks",
- "model": "MX240",
- "costPerUnit": 26250
}{ }[- {
- "purpose": "service/drop",
- "classifier": "highways",
- "costPerUnit": 1
}, - {
- "purpose": "service/drop",
- "classifier": "rural",
- "costPerUnit": 1
}, - {
- "purpose": "backhaul",
- "classifier": "rural",
- "costPerUnit": 1
}
]| purpose required | string (polePurpose) Enum: "service/drop" "link" "backhaul" "unclassified" intended purpose of the contents carried between (telegraph) poles |
| classifier required | string (heightClassifier) Enum: "residential" "rural" "commercial" "urban" "highways" "unclassified" summary of height of the (telegraph) pole |
| costPerUnit required | number <currency> >= 0 |
{- "purpose": "link",
- "classifier": "commercial",
- "costPerUnit": 1
}{ }| purpose required | string (polePurpose) Enum: "service/drop" "link" "backhaul" "unclassified" intended purpose of the contents carried between (telegraph) poles |
| classifier required | string (heightClassifier) Enum: "residential" "rural" "commercial" "urban" "highways" "unclassified" summary of height of the (telegraph) pole |
| costPerUnit required | number <currency> >= 0 |
{- "purpose": "link",
- "classifier": "commercial",
- "costPerUnit": 2.5
}{ }| purpose required | string (polePurpose) Enum: "service/drop" "link" "backhaul" "unclassified" intended purpose of the contents carried between (telegraph) poles |
| classifier required | string (heightClassifier) Enum: "residential" "rural" "commercial" "urban" "highways" "unclassified" summary of height of the (telegraph) pole |
{- "purpose": "link",
- "classifier": "commercial"
}{ }| slots required | integer (rackSlots) [ 1 .. 58 ] number of physical slots in the rack, 1=1U, 42=42U etc. |
| costPerUnit required | number <currency> >= 0 |
{- "slots": 24,
- "costPerUnit": 24
}{ }| slots required | integer (rackSlots) [ 1 .. 58 ] number of physical slots in the rack, 1=1U, 42=42U etc. |
| costPerUnit required | number <currency> >= 0 |
{- "slots": 48,
- "costPerUnit": 50
}{ }| slots required | integer (rackSlots) [ 1 .. 58 ] number of physical slots in the rack, 1=1U, 42=42U etc. |
{- "slots": 48
}{ }[- {
- "type": "broadband",
- "rate": 67,
- "unit": "Mbps",
- "costPerUnit": 31.23
}, - {
- "type": "optical",
- "rate": 1,
- "unit": "Gbps",
- "costPerUnit": 256.78
}, - {
- "type": "optical",
- "rate": 1,
- "unit": "Gbps",
- "lagMembers": 2,
- "costPerUnit": 512.34
}, - {
- "type": "sogea",
- "rate": 1,
- "unit": "Gbps",
- "costPerUnit": 62.46
}, - {
- "type": "unclassified",
- "rate": 1,
- "unit": "Gbps",
- "costPerUnit": 100
}
]| type required | string (serviceType) Enum: "broadband" "circuit" "ethernet" "fttx" "optical" "sogea" "unclassified" "voice" intended offering of the suppplied service, note:
|
| rate required | integer [ 1 .. 768 ] |
| unit required | string Enum: "Mbps" "Gbps" "Tbps" |
| lagMembers | integer [ 0 .. 256 ] Default: 0 |
| costPerUnit required | number <currency> >= 0 |
{- "type": "circuit",
- "rate": 256,
- "unit": "Mbps",
- "costPerUnit": 34.56
}{ }| type required | string (serviceType) Enum: "broadband" "circuit" "ethernet" "fttx" "optical" "sogea" "unclassified" "voice" intended offering of the suppplied service, note:
|
| rate required | integer [ 1 .. 768 ] |
| unit required | string Enum: "Mbps" "Gbps" "Tbps" |
| lagMembers | integer [ 0 .. 256 ] Default: 0 |
| costPerUnit required | number <currency> >= 0 |
{- "type": "circuit",
- "rate": 256,
- "unit": "Mbps",
- "costPerUnit": 56.78
}{ }| type required | string (serviceType) Enum: "broadband" "circuit" "ethernet" "fttx" "optical" "sogea" "unclassified" "voice" intended offering of the suppplied service, note:
|
| rate required | integer [ 1 .. 768 ] |
| unit required | string Enum: "Mbps" "Gbps" "Tbps" |
| lagMembers | integer [ 0 .. 256 ] Default: 0 |
{- "type": "circuit",
- "rate": 256,
- "unit": "Mbps"
}{ }[- {
- "area": "industrial",
- "type": "dc",
- "costPerUnit": 1
}, - {
- "area": "mixed",
- "type": "colo",
- "costPerUnit": 1
}, - {
- "area": "psz",
- "type": "pop",
- "costPerUnit": 1
}, - {
- "area": "residential",
- "type": "street",
- "costPerUnit": 1
}, - {
- "area": "rural",
- "type": "street",
- "costPerUnit": 1
}, - {
- "area": "urban",
- "type": "exchange",
- "costPerUnit": 1
}
]| area required | string (areaType) Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
|
| type required | string (siteType) Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
|
| costPerUnit required | number <currency> >= 0 |
{- "area": "mixed",
- "type": "street",
- "costPerUnit": 1
}{ }| area required | string (areaType) Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
|
| type required | string (siteType) Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
|
| costPerUnit required | number <currency> >= 0 |
{- "area": "mixed",
- "type": "street",
- "costPerUnit": 2.5
}{ }| area required | string (areaType) Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
|
| type required | string (siteType) Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
|
{- "area": "psz",
- "type": "exchange"
}{ }| purpose required | string (trenchPurpose) Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified" intended purpose of the contents of the trench |
| type | string (constructionType) Enum: "micro" "narrow" "backhoe" "inline" "portable" "large" only include when purpose is |
| unit required | string (sizeUnit) Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet" unit of measure of the dimension:
|
| costPerUnit required | number <currency> >= 0 |
{- "purpose": "service/drop",
- "unit": "m",
- "costPerUnit": 5
}{ }| purpose required | string (trenchPurpose) Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified" intended purpose of the contents of the trench |
| type | string (constructionType) Enum: "micro" "narrow" "backhoe" "inline" "portable" "large" only include when purpose is |
| unit required | string (sizeUnit) Enum: "cm" "mm" "m" "km" "Mm" "inch" "feet" unit of measure of the dimension:
|
| costPerUnit required | number <currency> >= 0 |
{- "purpose": "service/drop",
- "unit": "m",
- "costPerUnit": 5.5
}{ }| purpose required | string (trenchPurpose) Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified" intended purpose of the contents of the trench |
| type | string (constructionType) Enum: "micro" "narrow" "backhoe" "inline" "portable" "large" only include when purpose is |
{- "purpose": "service/drop"
}{ }[- {
- "cableId": "7573781c-4b1d-4530-877e-97e4e8d3057f",
- "country": "ABW",
- "cost": 0,
- "poleId": "0a67dabd-85c0-4dcf-a17f-47813de2d7ab",
- "point": "stringstringstr",
- "technology": "coax",
- "configuration": {
- "strands": 1,
- "mode": "SMOF",
- "rate": 10,
- "unit": "Gbps",
- "states": [
- {
- "strand": 1,
- "state": "free"
}
]
}, - "state": "free",
- "source": "historical",
- "probability": 0,
- "delete": false
}
]| cableId | string <uuid> (cableId) optionally specify the internal cable identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| poleId required | string <uuid> (poleId) internal pole identifier |
| point required | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| technology required | string (cableTechnology) Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber" technology domain of cable |
required | object or object or object or object or object (cableConfiguration) |
| state required | string (cableState) Enum: "free" "used" "reserved" "faulty" usage state of cable |
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
[- {
- "cableId": "7573781c-4b1d-4530-877e-97e4e8d3057f",
- "country": "ABW",
- "cost": 0,
- "poleId": "0a67dabd-85c0-4dcf-a17f-47813de2d7ab",
- "point": "stringstringstr",
- "technology": "coax",
- "configuration": {
- "strands": 1,
- "mode": "SMOF",
- "rate": 10,
- "unit": "Gbps",
- "states": [
- {
- "strand": 1,
- "state": "free"
}
]
}, - "state": "free",
- "source": "historical",
- "probability": 0,
- "delete": false
}
][- "5520aca1-4727-431a-aa9c-23f2e54b8a41"
]| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "3970af86-e19f-4e4c-810b-246aea08f941",
- "84eabb13-c76e-466d-8993-7d7ee4695682",
- "31d0f438-0f60-4b09-917e-95f373af9fd2",
- "c731866d-7347-4e56-acf9-abab931cf83e",
- "6bbbd7f1-f551-489b-abfc-fcf0be0880ce",
- "d321fc40-8cb9-4db5-99d7-5c5e96d2a146",
- "d5527663-e75f-41c5-a7a4-7db82ed49b07",
- "77ece265-d111-40c6-b4e2-1aa5e8c182aa",
- "b8e322d3-6004-43ad-93c1-7ba73ec4fe97"
]| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
| poleId required | string <uuid> (poleId) internal pole identifier |
| technology required | string (cableTechnology) Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber" technology domain of cable |
required | object or object or object or object or object (cableConfiguration) |
| state | string (cableState) Enum: "free" "used" "reserved" "faulty" usage state of cable |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
- "country": "BEL",
- "cost": 2.5,
- "technology": "ethernet",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps",
- "state": "free"
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{- "cableId": "5520aca1-4727-431a-aa9c-23f2e54b8a41"
}| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "total": 123,
- "active": 91,
- "inactive": 32
}| from | string = 8 characters ^\d{8}$ range start date format in compressed ISO-8601. (
|
| to | string = 8 characters ^\d{8}$ range end date format in compressed ISO-8601. (
|
| before | string = 8 characters ^\d{8}$ before date format in compressed ISO-8601. (
|
| after | string = 8 characters ^\d{8}$ after date format in compressed ISO-8601. (
|
| aggregate required | string Enum: "day" "week" "month" "quarter" "half-year" "year" unit of measure of the aggregation factor |
{- "by": "hour",
- "cable": [
- {
- "cableId": "7573781c-4b1d-4530-877e-97e4e8d3057f",
- "ductId": "4f71ba05-6d3f-4e7f-aaef-efaafefa0ba8",
- "technology": "coax",
- "capacity": [
- {
- "period": "stri",
- "strands": [
- {
- "strand": 1,
- "state": "free"
}
]
}
]
}
]
}| cableId required | string <uuid> internal cable identifier |
| predicted | null Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only |
| restore | null Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged |
{ }| cableId required | string <uuid> internal cable identifier |
| ductId required | string <uuid> (ductId) internal duct identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
| technology required | string (cableTechnology) Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber" technology domain of cable |
required | object or object or object or object or object (cableConfiguration) |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
- "country": "BEL",
- "technology": "multiFiber",
- "configuration": {
- "ribbons": 2,
- "strands": 2,
- "mode": "MMOF",
- "states": [
- {
- "ribbon": 1,
- "strand": 1,
- "state": "free"
}, - {
- "ribbon": 1,
- "strand": 2,
- "state": "free"
}, - {
- "ribbon": 2,
- "strand": 1,
- "state": "used"
}, - {
- "ribbon": 2,
- "strand": 2,
- "state": "used"
}
]
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| cableId required | string <uuid> internal cable identifier |
| cableId | string <uuid> (cableId) internal cable identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
| ductId | string <uuid> (ductId) internal duct identifier |
| technology | string (cableTechnology) Enum: "coax" "copper" "ethernet" "singleFiber" "multiFiber" technology domain of cable |
object or object or object or object or object (cableConfiguration) | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "cableId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
- "country": "BEL",
- "technology": "multiFiber",
- "configuration": {
- "ribbons": 24,
- "strands": 48,
- "mode": "MMOF",
- "states": [
- {
- "ribbon": 1,
- "strand": 1,
- "state": "free"
}
]
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| cableId required | string <uuid> internal cable identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "cableId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps",
- "state": "used"
}, - "technology": "ethernet",
- "source": "historical",
- "probability": 1,
- "delete": false
}| cableId required | string <uuid> internal cable identifier |
| strand required | integer [ 1 .. 48 ] fiber optic cable strand number |
| state | string (cableState) Enum: "free" "used" "reserved" "faulty" usage state of cable |
{- "state": "used"
}{ }| cableId required | string <uuid> internal cable identifier |
| ribbon required | integer [ 1 .. 36 ] fiber optic cable ribbon number |
| strand required | integer [ 1 .. 48 ] fiber optic cable strand number |
| state | string (cableState) Enum: "free" "used" "reserved" "faulty" usage state of cable |
{- "state": "used"
}{ }| cableId required | string <uuid> internal cable identifier |
| channel required | integer [ 1 .. 512 ] channel number within the frequency range |
| state | string (cableState) Enum: "free" "used" "reserved" "faulty" usage state of cable |
{- "state": "used"
}{ }| cableId required | string <uuid> internal cable identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "predicted",
- "probability": 0.25
}
]| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
[- {
- "currencyId": "578a82ad-a7ce-4f9c-ba5f-fbe27c1886f5",
- "name": "Euro",
- "symbol": "€",
- "isoCode": "EUR",
- "rate": 1
}, - {
- "currencyId": "007fa4b5-9776-4e99-a116-095398b5d47a",
- "name": "Sterling",
- "symbol": "£",
- "isoCode": "GBP",
- "rate": 0.85
}, - {
- "currencyId": "300e2d59-e873-4ecc-a3ad-58e44e3f3c03",
- "name": "United States dollar",
- "symbol": "$",
- "isoCode": "USD",
- "rate": 1.17
}
]| currencyId required | string <uuid> internal currency identifier |
| rate required | number <currency> >= 0 |
{- "rate": 0.85
}{ }[- {
- "ductId": "4f71ba05-6d3f-4e7f-aaef-efaafefa0ba8",
- "point": "stringstringstr",
- "country": "ABW",
- "cost": 0,
- "trenchId": "f175238a-c421-4dea-a8c0-f696218f3848",
- "purpose": "gas",
- "category": "duct",
- "configuration": 1,
- "state": "free",
- "within": "0e6ec09f-2104-426c-8cf9-7b94b25ea2e9",
- "placement": {
- "vertical": 350,
- "horizontal": 1579,
- "unit": "cm"
}, - "source": "historical",
- "probability": 0,
- "delete": false
}
]| ductId | string <uuid> (ductId) optionally specify the internal duct identifier |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| trenchId required | string <uuid> (trenchId) internal trench identifier |
| purpose required | string (ductPurpose) Enum: "gas" "power" "cable" "water" intended contents of the duct, note: |
| category required | string (ductSizeCategory) Enum: "duct" "subduct" size classification of the duct |
| configuration required | integer (ductConfiguration) [ 1 .. 48 ] 1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle |
| state required | string (ductState) Enum: "free" "used" "reserved" "faulty" state of duct |
| within | string <uuid> (ductId) for a microduct or subduct which duct or microduct is it contained within |
required | object (ductPlacement) horizontal and vertical placement of the duct within the trench |
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
[- {
- "ductId": "4f71ba05-6d3f-4e7f-aaef-efaafefa0ba8",
- "point": "stringstringstr",
- "country": "ABW",
- "cost": 0,
- "trenchId": "f175238a-c421-4dea-a8c0-f696218f3848",
- "purpose": "gas",
- "category": "duct",
- "configuration": 1,
- "state": "free",
- "within": "0e6ec09f-2104-426c-8cf9-7b94b25ea2e9",
- "placement": {
- "vertical": 350,
- "horizontal": 1579,
- "unit": "cm"
}, - "source": "historical",
- "probability": 0,
- "delete": false
}
][- "4f61c862-cbd6-4455-9cf2-3d478406c693"
]| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "total": 123,
- "active": 91,
- "inactive": 32
}| trenchId required | string <uuid> (trenchId) internal trench identifier |
| purpose required | string (ductPurpose) Enum: "gas" "power" "cable" "water" intended contents of the duct, note: |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| reference | string |
| cost | number <currency> |
| category required | string (ductSizeCategory) Enum: "duct" "subduct" size classification of the duct |
| configuration required | integer (ductConfiguration) [ 1 .. 48 ] 1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle |
| state required | string (ductState) Enum: "free" "used" "reserved" "faulty" state of duct |
| within | string <uuid> (ductId) for a microduct or subduct which duct or microduct is it contained within |
required | object (ductPlacement) horizontal and vertical placement of the duct within the trench |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
- "country": "BEL",
- "purpose": "cable",
- "category": "microduct",
- "configuration": 24,
- "state": "free",
- "placement": {
- "horizontal": 1579,
- "vertical": 350,
- "unit": "mm"
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{- "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693"
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- "4f61c862-cbd6-4455-9cf2-3d478406c693",
- "1ed39d9c-b95b-4745-a93c-f2fd49ef740d",
- "74d91189-0b4f-4734-9666-b3b030502e80",
- "253c57de-00ef-4819-b509-b99e82990125",
- "eadfd1fb-2356-4666-9fd1-288bb393fa2a",
- "b78af928-5e4f-43f3-bc61-fcef3af0740f",
- "d9d00870-f242-4597-8168-152e0945709a",
- "224c9a62-f49e-4ff8-a4cb-b20dab18345a",
- "cec8b457-59ce-4b13-9627-b2d0a15248c5",
- "f9f67501-9674-47a2-a0dc-d40f9c6554aa"
]| from | string = 8 characters ^\d{8}$ range start date format in compressed ISO-8601. (
|
| to | string = 8 characters ^\d{8}$ range end date format in compressed ISO-8601. (
|
| before | string = 8 characters ^\d{8}$ before date format in compressed ISO-8601. (
|
| after | string = 8 characters ^\d{8}$ after date format in compressed ISO-8601. (
|
| aggregate required | string Enum: "day" "week" "month" "quarter" "half-year" "year" unit of measure of the aggregation factor |
{- "by": "quarter",
- "duct": [
- {
- "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
- "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
- "capacity": [
- {
- "period": "Q32024",
- "state": "free"
}, - {
- "period": "Q42024",
- "state": "used"
}, - {
- "period": "Q12025",
- "state": "used"
}
]
}, - {
- "ductId": "1ed39d9c-b95b-4745-a93c-f2fd49ef740d",
- "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
- "capacity": [
- {
- "period": "Q32024",
- "state": "free"
}, - {
- "period": "Q42024",
- "state": "free"
}, - {
- "period": "Q12025",
- "state": "free"
}
]
}
]
}| ductId required | string <uuid> internal duct identifier |
| predicted | null Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only |
| restore | null Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged |
{ }| ductId required | string <uuid> internal duct identifier |
| trenchId required | string <uuid> (trenchId) internal trench identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| reference | string |
| cost | number <currency> |
| purpose required | string (ductPurpose) Enum: "gas" "power" "cable" "water" intended contents of the duct, note: |
| category required | string (ductSizeCategory) Enum: "duct" "subduct" size classification of the duct |
| configuration required | integer (ductConfiguration) [ 1 .. 48 ] 1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle |
| state required | string (ductState) Enum: "free" "used" "reserved" "faulty" state of duct |
| within | string <uuid> (ductId) for a microduct or subduct which duct or microduct is it contained within |
required | object (ductPlacement) horizontal and vertical placement of the duct within the trench |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
- "country": "BEL",
- "purpose": "cable",
- "category": "microduct",
- "configuration": 12,
- "state": "free",
- "placement": {
- "horizontal": 1579,
- "vertical": 350,
- "unit": "mm"
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| ductId required | string <uuid> internal duct identifier |
| trenchId | string <uuid> (trenchId) internal trench identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| reference | string |
| cost | number <currency> |
| purpose | string (ductPurpose) Enum: "gas" "power" "cable" "water" intended contents of the duct, note: |
| category | string (ductSizeCategory) Enum: "duct" "subduct" size classification of the duct |
| configuration | integer (ductConfiguration) [ 1 .. 48 ] 1/2/3/5/6/7/8/10/12/14/19/24-way (etc.) type of duct bundle |
| state | string (ductState) Enum: "free" "used" "reserved" "faulty" state of duct |
| within | string <uuid> (ductId) for a microduct or subduct which duct or microduct is it contained within |
object (ductPlacement) horizontal and vertical placement of the duct within the trench | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "state": "used"
}{ }| ductId required | string <uuid> internal duct identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "ductId": "4f61c862-cbd6-4455-9cf2-3d478406c693",
- "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
- "country": "BEL",
- "purpose": "cable",
- "category": "microduct",
- "configuration": 24,
- "state": "used",
- "placement": {
- "horizontal": 1579,
- "vertical": 350,
- "unit": "mm"
}, - "source": "historical",
- "probability": 1,
- "delete": false
}| ductId required | string <uuid> internal duct identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "predicted",
- "probability": 0.25
}
]| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
[- {
- "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
- "country": "ABW",
- "cost": 0,
- "point": "stringstringstr",
- "reference": "string",
- "customer": {
- "name": "string",
- "reference": "string"
}, - "commissioned": "stringst",
- "decommissioned": "stringst",
- "lag": {
- "group": "string",
- "members": 0
}, - "link": {
- "ingress": [
- {
- "neId": "7ca9ce18-ea71-4e54-a477-f54278be06b4",
- "port": "string",
- "cVlanId": 0,
- "sVlanId": 0,
- "member": 0
}
], - "egress": [
- {
- "neId": "7ca9ce18-ea71-4e54-a477-f54278be06b4",
- "port": "string",
- "cVlanId": 0,
- "sVlanId": 0,
- "member": 0
}
]
}, - "source": "historical",
- "probability": 0,
- "delete": false
}
]| serviceId | string <uuid> (serviceId) optionally specify the internal service identifier |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
required | object |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
object Link Aggregation Group for bundling multiple connection points | |
required | object |
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
[- {
- "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9",
- "point": "stringstringstr",
- "country": "ABW",
- "cost": 0,
- "reference": "string",
- "customer": {
- "name": "string",
- "reference": "string"
}, - "commissioned": "stringst",
- "decommissioned": "stringst",
- "lag": {
- "group": "string",
- "members": 0
}, - "link": {
- "ingress": [
- {
- "neId": "7ca9ce18-ea71-4e54-a477-f54278be06b4",
- "port": "string",
- "cVlanId": 0,
- "sVlanId": 0,
- "member": 0
}
], - "egress": [
- {
- "neId": "7ca9ce18-ea71-4e54-a477-f54278be06b4",
- "port": "string",
- "cVlanId": 0,
- "sVlanId": 0,
- "member": 0
}
]
}, - "source": "historical",
- "probability": 0,
- "delete": false
}
][- "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c"
]| serviceId required | string <uuid> internal service identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "predicted",
- "probability": 0.25
}
]| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "total": 123,
- "active": 91,
- "inactive": 32
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- "dab18895-c0ab-4267-815c-1d04b1b66586",
- "be0b48c3-b149-42c7-abdc-65ac8a635f79",
- "97fc88b7-f292-410d-8e5e-99644da22eb6",
- "21f9393b-f07c-4007-bc40-ddf583c44204",
- "6af1aa26-0e73-45a3-8593-d9dda68d9e21",
- "7b253875-48c5-4cf7-b46a-495f67d2c58d",
- "a0f8a856-38ae-430c-a648-7a46534e1ac6",
- "e80a4d88-d56b-4d35-b25d-ab68e17d09c6",
- "88a1237b-3a03-4037-ad5f-cc4c705b8e53",
- "e6e6a1c9-b233-477b-9e2d-58b99ca26fbe"
]| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference required | string |
required | object |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| rate | integer [ 1 .. 768 ] Default: 0 maximum service rate |
| unit | string Default: "Gbps" Enum: "Mbps" "Gbps" "Tbps" unit of service rate |
object Link Aggregation Group for bundling multiple connection points | |
required | object |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "reference": "ZX2034-10-10",
- "country": "BEL",
- "customer": {
- "name": "Bluevia",
- "reference": "sample"
}, - "commissioned": "20241010",
- "rate": 1,
- "unit": "Gbps",
- "lag": {
- "group": "LAG1",
- "members": 2
}, - "link": {
- "ingress": [
- {
- "neId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "port": "ge-0/0/1",
- "cVlanId": 0,
- "member": 1
}, - {
- "neId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "port": "ge-0/0/2",
- "cVlanId": 0,
- "member": 2
}
], - "egress": [
- {
- "neId": "9fa85349-4a8d-4014-bf95-344fdfad1a7f",
- "port": "ge-0/0/1",
- "cVlanId": 0,
- "member": 1
}, - {
- "neId": "1074dfb1-b03d-484f-b46a-35957669d468",
- "port": "ge-0/0/2",
- "cVlanId": 0,
- "member": 2
}
]
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{- "serviceId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c"
}| serviceId required | string <uuid> internal service identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
object | |
| commissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| rate | integer [ 0 .. 768 ] maximum service rate |
| unit | string Enum: "Mbps" "Gbps" "Tbps" unit of service rate |
object Link Aggregation Group for bundling multiple connection points | |
object | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "link": {
- "ingress": [
- {
- "neId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "port": "ge-1/0/1"
}
], - "egress": [
- {
- "neId": "9fa85349-4a8d-4014-bf95-344fdfad1a7f",
- "port": "ge-1/0/1"
}
]
}
}{ }| serviceId required | string <uuid> internal service identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
required | object |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| rate | integer [ 0 .. 768 ] Default: 0 maximum service rate |
| unit | string Default: "Gbps" Enum: "Mbps" "Gbps" "Tbps" unit of service rate |
object Link Aggregation Group for bundling multiple connection points | |
required | object |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "reference": "ZX2034-10-10",
- "country": "BEL",
- "customer": {
- "name": "Bluevia",
- "reference": "sample"
}, - "commissioned": "20241010",
- "rate": 1,
- "unit": "Gbps",
- "lag": {
- "group": "LAG1",
- "members": 2
}, - "link": {
- "ingress": [
- {
- "neId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "port": "ge-1/0/1",
- "cVlanId": 0,
- "member": 1
}, - {
- "neId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "port": "ge-0/0/2",
- "cVlanId": 0,
- "member": 2
}
], - "egress": [
- {
- "neId": "9fa85349-4a8d-4014-bf95-344fdfad1a7f",
- "port": "ge-0/0/1",
- "cVlanId": 0,
- "member": 1
}, - {
- "neId": "1074dfb1-b03d-484f-b46a-35957669d468",
- "port": "ge-0/0/2",
- "cVlanId": 0,
- "member": 2
}
]
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| serviceId required | string <uuid> internal service identifier |
| predicted | null Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only |
| restore | null Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged |
{ }| serviceId required | string <uuid> internal service identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "serviceId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "reference": "ZX2034-10-10",
- "country": "BEL",
- "customer": {
- "name": "Bluevia",
- "reference": "sample"
}, - "commissioned": "20241010",
- "rate": 1,
- "unit": "Gbps",
- "lag": {
- "group": "LAG1",
- "members": 2
}, - "link": {
- "ingress": [
- {
- "neId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "port": "ge-0/0/1",
- "cVlanId": 0,
- "member": 1
}, - {
- "neId": "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "port": "ge-0/0/2",
- "cVlanId": 0,
- "member": 2
}
], - "egress": [
- {
- "neId": "9fa85349-4a8d-4014-bf95-344fdfad1a7f",
- "port": "ge-0/0/1",
- "cVlanId": 0,
- "member": 1
}, - {
- "neId": "1074dfb1-b03d-484f-b46a-35957669d468",
- "port": "ge-0/0/2",
- "cVlanId": 0,
- "member": 2
}
]
}, - "source": "historical",
- "probability": 1,
- "delete": false
}[- {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "point": "stringstringstr",
- "reference": "string",
- "commissioned": "stringst",
- "decommissioned": "stringst",
- "area": "residential",
- "type": "adu",
- "cost": 0,
- "location": {
- "country": "ABW",
- "region": "string",
- "town": "string",
- "district": "string",
- "street": "string",
- "premisesNameNumber": "string",
- "postalCode": "string",
- "coordinate": {
- "x": 0,
- "y": 0,
- "z": 0,
- "m": "string"
}
}, - "source": "historical",
- "probability": 0,
- "delete": false
}
]| siteId | string <uuid> (siteId) optionally specify the site internal identifier |
| point required | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| reference required | string |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| area | string (areaType) Default: "unclassified" Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
|
| type | string (siteType) Default: "unclassified" Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
|
| cost | number <currency> |
required | object |
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
[- {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "point": "stringstringstr",
- "reference": "string",
- "commissioned": "stringst",
- "decommissioned": "stringst",
- "area": "residential",
- "type": "adu",
- "cost": 0,
- "location": {
- "country": "ABW",
- "region": "string",
- "town": "string",
- "district": "string",
- "street": "string",
- "premisesNameNumber": "string",
- "postalCode": "string",
- "coordinate": {
- "x": 0,
- "y": 0,
- "z": 0,
- "m": "string"
}
}, - "source": "historical",
- "probability": 0,
- "delete": false
}
][- "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c"
]| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "total": 123,
- "active": 91,
- "inactive": 32
}| from required | string <uuid> (siteId) internal site identifier |
| to required | string <uuid> (siteId) internal site identifier |
{- "from": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "to": "0de00152-657a-43c8-92ba-245428a23d74"
}{- "distance": 17.234567,
- "unit": "m"
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- "07bc9f28-cc27-4f3a-958b-dd8fd1034c2c",
- "0de00152-657a-43c8-92ba-245428a23d74",
- "582ad17e-d1cc-41f9-8277-09b2f7112d58",
- "7060d226-d483-43c6-8432-4ed4de0fcd27",
- "bdf1c15a-c91f-472f-bde6-2b3ff212b051",
- "ffb9e869-a240-4a99-9f46-109802fb44e6",
- "532dc221-d753-4799-815c-d7b9d36c59bc",
- "43939c0a-fade-44d5-9eb3-4e50f9698d13",
- "2e8c5466-4d0c-4193-91e0-605a45770833",
- "e883b5ce-fca6-474d-873a-7b7cdaef097e"
]| reference required | string |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| onNet | boolean Default: false |
| area | string (areaType) Default: "unclassified" Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
|
| type | string (siteType) Default: "unclassified" Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
|
| cost | number <currency> |
required | object |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "reference": "esp-zar-daro1",
- "commissioned": "20241010",
- "onNet": true,
- "area": "commercial",
- "type": "exchange",
- "location": {
- "country": "ESP",
- "region": "Zaragoza",
- "town": "Daroca",
- "street": "Avenue",
- "premisesNameNumber": "32",
- "postalCode": "91234",
- "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- {
- "siteId": "01d6c476-16f8-4c86-9e5b-3caa733b217d",
- "reference": "1 Elmley Lane, WR9 0PN",
- "area": "rural",
- "type": "street",
- "postalCode": "WR9 0PN",
- "country": "GBR"
}
]| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- {
- "siteId": "07ebecfd-5341-4f02-88f8-4f5330398f69",
- "reference": "bel-zel-m1",
- "area": "urban",
- "type": "street",
- "postalCode": "1731",
- "country": "BEL"
}
]| siteId required | string <uuid> internal site identifier |
| reference | string |
| commissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| onNet | boolean Default: false |
| area | string (areaType) Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
|
| type | string (siteType) Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
|
| cost | number <currency> |
object | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "reference": "esp-zar-daro1",
- "commissioned": "20241010",
- "decommissioned": "20250931",
- "onNet": true,
- "area": "commercial",
- "type": "exchange",
- "location": {
- "country": "ESP",
- "region": "Zaragoza",
- "town": "Daroca",
- "street": "Avenue",
- "premisesNameNumber": "32",
- "postalCode": "91232",
- "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}
}
}{- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}| siteId required | string <uuid> internal site identifier |
| reference required | string |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| onNet | boolean Default: false |
| area | string (areaType) Enum: "residential" "rural" "industrial" "commercial" "mixed" "psz" "urban" "unclassified" "utility"
|
| type | string (siteType) Enum: "adu" "colo" "commercial" "dc" "exchange" "mdu" "pop" "sdu" "street" "unclassified"
|
| cost | number <currency> |
required | object |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "reference": "esp-zar-daro1",
- "commissioned": "20241010",
- "onNet": true,
- "area": "commercial",
- "type": "exchange",
- "location": {
- "country": "ESP",
- "region": "Zaragoza",
- "town": "Daroca",
- "street": "Avenue",
- "premisesNameNumber": "32",
- "postalCode": "91232",
- "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| siteId required | string <uuid> internal site identifier |
| predicted | null Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only |
| restore | null Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged |
{ }| siteId required | string <uuid> internal site identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
- "reference": "esp-zar-daro1",
- "commissioned": "20241010",
- "onNet": true,
- "area": "commercial",
- "type": "exchange",
- "location": {
- "country": "ESP",
- "region": "Zaragoza",
- "town": "Daroca",
- "street": "Avenue",
- "premisesNameNumber": "32",
- "postalCode": "91234",
- "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}
}, - "source": "historical",
- "probability": 1,
- "delete": false
}| siteId required | string <uuid> internal site identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "predicted",
- "probability": 0.25
}
][- {
- "rackId": "6b594d5c-dec3-4d92-9068-c47ab010a3f3",
- "point": "stringstringstr",
- "country": "ABW",
- "cost": 0,
- "reference": "string",
- "commissioned": "stringst",
- "decommissioned": "stringst",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "floor": 0,
- "area": "string",
- "row": 0,
- "column": 0,
- "coordinate": {
- "x": 0,
- "y": 0,
- "z": 0,
- "m": "string"
}, - "dimensions": {
- "depth": 914.4,
- "height": 2000,
- "width": 600,
- "unit": "cm"
}, - "slots": 42,
- "source": "historical",
- "probability": 0,
- "delete": false
}
]| rackId | string <uuid> (rackId) optionally specify the internal rack identifier |
| point required | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference required | string |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| siteId required | string <uuid> (siteId) internal site identifier |
| floor | integer floor level, 0 is ground level |
| area | string room or allocated area |
| row | integer >= 0 |
| column | integer >= 0 |
object (coordinate) A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:
| |
object (dimensions) Height x Width x Depth of the item with a specified unit of measure | |
| slots required | integer (rackSlots) [ 1 .. 58 ] number of physical slots in the rack, 1=1U, 42=42U etc. |
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
[- {
- "rackId": "6b594d5c-dec3-4d92-9068-c47ab010a3f3",
- "point": "stringstringstr",
- "country": "ABW",
- "cost": 0,
- "reference": "string",
- "commissioned": "stringst",
- "decommissioned": "stringst",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "floor": 0,
- "area": "string",
- "row": 0,
- "column": 0,
- "coordinate": {
- "x": 0,
- "y": 0,
- "z": 0,
- "m": "string"
}, - "dimensions": {
- "depth": 914.4,
- "height": 2000,
- "width": 600,
- "unit": "cm"
}, - "slots": 42,
- "source": "historical",
- "probability": 0,
- "delete": false
}
][- "a84eed87-277f-46ac-9ee3-094c0d104f1f"
]| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "total": 123,
- "active": 91,
- "inactive": 32
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- "a84eed87-277f-46ac-9ee3-094c0d104f1f",
- "fc1409a5-ddde-48af-858c-bb3b1f06cb02",
- "c86c169c-0cca-4b55-a71c-81f2d0dac49b",
- "f7c45506-435d-449a-a334-b438f9a7bee7",
- "ccdc9a6e-0728-4073-9c33-892e294315be",
- "fb66a40c-d6a4-41eb-a93a-07e2835908e6",
- "08678ce9-e188-4af7-bc39-a88af5b36b17",
- "617a6fc7-b9a2-4792-8f23-9c0d0919f699",
- "fa3f37c9-b663-47ca-8add-82f068cd3688",
- "98662042-c745-4fd0-af32-ecda683c5ca0"
]| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference required | string |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| siteId required | string <uuid> (siteId) internal site identifier |
| floor | integer floor level, 0 is ground level |
| area | string room or allocated area |
| row | integer >= 0 |
| column | integer >= 0 |
object (coordinate) A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:
| |
object (dimensions) Height x Width x Depth of the item with a specified unit of measure | |
| slots required | integer (rackSlots) [ 1 .. 58 ] number of physical slots in the rack, 1=1U, 42=42U etc. |
Array of objects slot usage is considered free unless indicated otherwise | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "country": "BEL",
- "reference": "esp-zar-f0-01",
- "commissioned": "20241010",
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
- "floor": 0,
- "area": "commercial",
- "row": 1,
- "column": 1,
- "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - "dimensions": {
- "depth": 914.4,
- "height": 2000,
- "width": 600,
- "unit": "mm"
}, - "slots": 42,
- "slotUsage": [
- {
- "slot": 1,
- "usage": "reserved"
}, - {
- "slot": 2,
- "usage": "used"
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}{- "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f"
}| rackId required | string <uuid> internal rack identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
| commissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| siteId | string <uuid> (siteId) internal site identifier |
| floor | integer floor level, 0 is ground level |
| area | string room or allocated area |
| row | integer >= 0 |
| column | integer >= 0 |
object (coordinate) A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:
| |
object (dimensions) Height x Width x Depth of the item with a specified unit of measure | |
| slots | integer (rackSlots) [ 1 .. 58 ] number of physical slots in the rack, 1=1U, 42=42U etc. |
Array of objects slot usage is considered free unless indicated otherwise | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "slotUsage": [
- {
- "slot": 3,
- "usage": "used"
}
]
}{ }| rackId required | string <uuid> internal rack identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference required | string |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| siteId required | string <uuid> (siteId) internal site identifier |
| floor | integer floor level, 0 is ground level |
| area | string room or allocated area |
| row | integer >= 0 |
| column | integer >= 0 |
object (coordinate) A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:
| |
object (dimensions) Height x Width x Depth of the item with a specified unit of measure | |
| slots | integer (rackSlots) [ 1 .. 58 ] number of physical slots in the rack, 1=1U, 42=42U etc. |
Array of objects slot usage is considered free unless indicated otherwise | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "reference": "esp-zar-f0-01",
- "country": "ESP",
- "commissioned": "20241010",
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
- "floor": 0,
- "area": "commercial",
- "row": 1,
- "column": 1,
- "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - "dimensions": {
- "depth": 914.4,
- "height": 2000,
- "width": 600,
- "unit": "mm"
}, - "slots": 42,
- "slotUsage": [
- {
- "slot": 1,
- "usage": "reserved"
}, - {
- "slot": 2,
- "usage": "used"
}, - {
- "slot": 3,
- "usage": "used"
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| rackId required | string <uuid> internal rack identifier |
| predicted | null Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only |
| restore | null Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged |
{ }| rackId required | string <uuid> internal rack identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
- "reference": "esp-zar-f0-01",
- "country": "ESP",
- "commissioned": "20241010",
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
- "floor": 0,
- "area": "commercial",
- "row": 1,
- "column": 1,
- "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - "dimensions": {
- "depth": 914.4,
- "height": 2000,
- "width": 600,
- "unit": "mm"
}, - "slots": 42,
- "slotUsage": [
- {
- "slot": 1,
- "usage": "reserved"
}, - {
- "slot": 2,
- "usage": "used"
}, - {
- "slot": 3,
- "usage": "used"
}, - {
- "slot": 4,
- "usage": "free"
}, - {
- "slot": 5,
- "usage": "free"
}, - {
- "slot": 6,
- "usage": "free"
}, - {
- "slot": 7,
- "usage": "free"
}, - {
- "slot": 8,
- "usage": "free"
}, - {
- "slot": 9,
- "usage": "free"
}, - {
- "slot": 10,
- "usage": "free"
}, - {
- "slot": 11,
- "usage": "free"
}, - {
- "slot": 12,
- "usage": "free"
}, - {
- "slot": 13,
- "usage": "free"
}, - {
- "slot": 14,
- "usage": "free"
}, - {
- "slot": 15,
- "usage": "free"
}, - {
- "slot": 16,
- "usage": "free"
}, - {
- "slot": 17,
- "usage": "free"
}, - {
- "slot": 18,
- "usage": "free"
}, - {
- "slot": 19,
- "usage": "free"
}, - {
- "slot": 20,
- "usage": "free"
}, - {
- "slot": 21,
- "usage": "free"
}, - {
- "slot": 22,
- "usage": "free"
}, - {
- "slot": 23,
- "usage": "free"
}, - {
- "slot": 24,
- "usage": "free"
}, - {
- "slot": 25,
- "usage": "free"
}, - {
- "slot": 26,
- "usage": "free"
}, - {
- "slot": 27,
- "usage": "free"
}, - {
- "slot": 28,
- "usage": "free"
}, - {
- "slot": 29,
- "usage": "free"
}, - {
- "slot": 30,
- "usage": "free"
}, - {
- "slot": 31,
- "usage": "free"
}, - {
- "slot": 32,
- "usage": "free"
}, - {
- "slot": 33,
- "usage": "free"
}, - {
- "slot": 34,
- "usage": "free"
}, - {
- "slot": 35,
- "usage": "free"
}, - {
- "slot": 36,
- "usage": "free"
}, - {
- "slot": 37,
- "usage": "free"
}, - {
- "slot": 38,
- "usage": "free"
}, - {
- "slot": 39,
- "usage": "free"
}, - {
- "slot": 40,
- "usage": "free"
}, - {
- "slot": 41,
- "usage": "free"
}, - {
- "slot": 42,
- "usage": "free"
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}| rackId required | string <uuid> internal rack identifier |
[- {
- "slot": 1,
- "usage": "reserved"
}, - {
- "slot": 2,
- "usage": "used"
}, - {
- "slot": 3,
- "usage": "free"
}, - {
- "slot": 4,
- "usage": "free"
}, - {
- "slot": 5,
- "usage": "faulty"
}, - {
- "slot": 6,
- "usage": "free"
}
]| rackId required | string <uuid> internal rack identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "predicted",
- "probability": 0.25
}
][- {
- "neId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
- "point": "20240831T000000",
- "country": "ESP",
- "host": "esp-zar-daro-01",
- "commissioned": "20241010",
- "siteId": "a91550d8-8d19-4f79-b00f-73f6a29c1182",
- "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
- "slotPosition": "1,2",
- "mgmtIP": "10.23.72.4",
- "vendor": "Juniper",
- "model": "MX240",
- "image": "JUNOS Base OS Boot",
- "version": "12.3R6.6",
- "ports": [
- {
- "name": "ge-0/0/0",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/1",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/2",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/3",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/4",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/5",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/6",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/7",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-1/1/0",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-1/1/1",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-1/1/2",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-1/1/3",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-2/1/0",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-2/1/1",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-2/1/2",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-2/1/3",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}
]| neId required | string <uuid> (neId) optionally specify the internal network equipment identifier |
| point required | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
| host required | string <hostname> |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| siteId required | string <uuid> |
| rackId required | string <uuid> |
| slotPosition required | string (rackSlotPosition) ([1-9]|[1-4][0-9]|5[0-8])+(,([1-9]|[1-4][0-9]... comma separated rack slot number in the range 1..58 |
| mgmtIP required | string <ipv4 ipv6>
|
| vendor required | string |
| model required | string |
| image required | string software firmware/image name |
| version required | string software firmware/image version |
| config | string CLI, JSON or XML (NETCONF/YANG) configuration, note: is stored automatically in compressed format |
required | Array of objects non-empty |
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
[- {
- "neId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
- "point": "20240831T000000",
- "country": "ESP",
- "host": "esp-zar-daro-01",
- "commissioned": "20241010",
- "siteId": "a91550d8-8d19-4f79-b00f-73f6a29c1182",
- "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
- "slotPosition": "1",
- "mgmtIP": "10.23.72.4",
- "vendor": "Juniper",
- "model": "MX240",
- "image": "JUNOS Base OS Boot",
- "version": "12.3R6.6",
- "ports": [
- {
- "name": "ge-0/0/0",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/1",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/2",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/3",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/4",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/5",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/6",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/7",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-1/1/0",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-1/1/1",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-1/1/2",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-1/1/3",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-2/1/0",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-2/1/1",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-2/1/2",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-2/1/3",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}
][- "86e420f1-137b-4e34-9ff7-18bd12743a10"
]| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "total": 123,
- "active": 91,
- "inactive": 32
}[- {
- "vendor": "Cisco Systems",
- "model": "C8300-1N1S-4T2X",
- "image": "IOS-XE SD-WAN",
- "version": "17.7.1a"
}, - {
- "vendor": "Juniper Networks",
- "model": "MX240",
- "image": "JUNOS Base OS Boot",
- "version": "12.3R6.6"
}
]| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- "86e420f1-137b-4e34-9ff7-18bd12743a10",
- "b43b07d6-a015-47a1-8108-fc686816c3b4",
- "2a59a345-7568-4cb1-9bb9-6a4ebf889d38",
- "d131b1c9-9d8f-4813-8838-a8021b6d3e9f",
- "d14d2b4b-abcd-4e8f-a71e-b9885ee48865",
- "4282053e-16c2-40c2-a6a8-15a7350c4f28",
- "59630b2-6d46-4d9e-9dc5-5b14803d1655",
- "6f3b3201-3630-4ca0-8949-2d9a3ae55e5f",
- "295f6c2b-c057-4bfa-881c-eb021a357790",
- "e2b55a83-8e81-437f-a3e0-7842b35b498b",
- "71e9cf2b-ec4b-4781-b31c-db0a26ba7da1",
- "b4fd1360-fa21-4e1e-82ea-8adb116586ca",
- "66fe0cfd-4483-43a7-8fa0-1835d5bc3727",
- "ba03d195-e046-4b58-895f-95089a370d76",
- "a63f9d02-7ca8-43ea-b8c0-51c58720d4fb"
]| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
| host required | string <hostname> |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| siteId required | string <uuid> |
| rackId required | string <uuid> |
| slotPosition required | string (rackSlotPosition) ([1-9]|[1-4][0-9]|5[0-8])+(,([1-9]|[1-4][0-9]... comma separated rack slot number in the range 1..58 |
| mgmtIP required | string <ipv4 ipv6>
|
| vendor required | string |
| model required | string |
| image required | string software firmware/image name |
| version required | string software firmware/image version |
| config | string CLI, JSON or XML (NETCONF/YANG) configuration, note: is stored automatically in compressed format |
required | Array of objects non-empty |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "host": "esp-zar-daro-01",
- "country": "ESP",
- "commissioned": "20241010",
- "siteId": "a91550d8-8d19-4f79-b00f-73f6a29c1182",
- "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
- "slotPosition": "2,3",
- "mgmtIP": "10.23.72.4",
- "vendor": "Juniper",
- "model": "MX240",
- "image": "JUNOS Base OS Boot",
- "version": "12.3R6.6",
- "ports": [
- {
- "name": "ge-0/0/0",
- "macAddress": "54:1e:56:e3:55:00",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/1",
- "macAddress": "54:1e:56:e3:55:01",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/2",
- "macAddress": "54:1e:56:e3:55:02",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/3",
- "macAddress": "54:1e:56:e3:55:03",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/4",
- "macAddress": "54:1e:56:e3:55:04",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/5",
- "macAddress": "54:1e:56:e3:55:05",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}
}, - {
- "name": "ge-0/0/6",
- "macAddress": "54:1e:56:e3:55:06",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/7",
- "macAddress": "54:1e:56:e3:55:07",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/0",
- "macAddress": "54:1e:56:e3:57:00",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/1",
- "macAddress": "54:1e:56:e3:57:01",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/2",
- "macAddress": "54:1e:56:e3:57:02",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/3",
- "macAddress": "54:1e:56:e3:57:03",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/0",
- "macAddress": "54:1e:56:e3:59:00",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/1",
- "macAddress": "54:1e:56:e3:59:01",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/2",
- "macAddress": "54:1e:56:e3:59:02",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/3",
- "macAddress": "54:1e:56:e3:59:03",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}{- "neId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}| neId required | string <uuid> internal network equipment identifier |
| predicted | null Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only |
| restore | null Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged |
{ }| neId required | string <uuid> internal network equipment identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "neId": "86e420f1-137b-4e34-9ff7-18bd12743a10",
- "host": "esp-zar-daro-01",
- "country": "ESP",
- "commissioned": "20241010",
- "siteId": "a91550d8-8d19-4f79-b00f-73f6a29c1182",
- "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
- "slotPosition": "1",
- "mgmtIP": "10.23.72.4",
- "vendor": "Juniper",
- "model": "MX240",
- "image": "JUNOS Base OS Boot",
- "version": "12.3R6.6",
- "ports": [
- {
- "name": "ge-0/0/0",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/1",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/2",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/3",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/4",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/5",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/6",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/7",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/0",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/1",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/2",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/3",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/0",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/1",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/2",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/3",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}| neId required | string <uuid> internal network equipment identifier |
| host required | string <hostname> |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
| commissioned required | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| siteId required | string <uuid> |
| rackId required | string <uuid> |
| slotPosition required | string (rackSlotPosition) ([1-9]|[1-4][0-9]|5[0-8])+(,([1-9]|[1-4][0-9]... comma separated rack slot number in the range 1..58 |
| mgmtIP required | string <ipv4 ipv6>
|
| vendor required | string |
| model required | string |
| image required | string software firmware/image name |
| version required | string software firmware/image version |
| config | string CLI, JSON or XML (NETCONF/YANG) configuration, note: is stored automatically in compressed format |
required | Array of objects non-empty |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "host": "esp-zar-daro-01",
- "country": "ESP",
- "commissioned": "20241010",
- "siteId": "a91550d8-8d19-4f79-b00f-73f6a29c1182",
- "rackId": "a84eed87-277f-46ac-9ee3-094c0d104f1f",
- "slotPosition": "2,3",
- "mgmtIP": "10.23.72.4",
- "vendor": "Juniper",
- "model": "MX240",
- "image": "JUNOS Base OS Boot",
- "version": "12.3R6.6",
- "ports": [
- {
- "name": "ge-0/0/0",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/1",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/2",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/3",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/4",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/5",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/6",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-0/0/7",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/0",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/1",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/2",
- "technology": "ethernet",
- "state": "free",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-1/1/3",
- "technology": "ethernet",
- "state": "used",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/0",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/1",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/2",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}, - {
- "name": "ge-2/1/3",
- "technology": "ethernet",
- "state": "reserved",
- "configuration": {
- "category": "Cat6A",
- "rate": 10,
- "unit": "Gbps"
}, - "errorCount": 0
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| neId required | string <uuid> internal network equipment identifier |
| host | string <hostname> |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| cost | number <currency> |
| reference | string |
| commissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| decommissioned | string (date) = 8 characters ^\d{8}$ MNI date format in compressed ISO-8601. (
|
| siteId | string <uuid> |
| rackId | string <uuid> |
| slotPosition | string (rackSlotPosition) ([1-9]|[1-4][0-9]|5[0-8])+(,([1-9]|[1-4][0-9]... comma separated rack slot number in the range 1..58 |
| mgmtIP | string <ipv4 ipv6>
|
| vendor | string |
| model | string |
| image | string software firmware/image name |
| version | string software firmware/image version |
| config | string CLI, JSON or XML (NETCONF/YANG) configuration, note: is stored automatically in compressed format |
Array of objects non-empty | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "version": "12.3R6.8"
}{ }| neId required | string <uuid> internal network equipment identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "predicted",
- "probability": 0.25
}
][- {
- "poleId": "0a67dabd-85c0-4dcf-a17f-47813de2d7ab",
- "point": "stringstringstr",
- "purpose": "service/drop",
- "country": "ABW",
- "construction": {
- "height": 0,
- "classifier": "residential",
- "unit": "cm",
- "cost": 0
}, - "demographics": {
- "premises": {
- "passed": 0,
- "area": "residential"
}
}, - "build": {
- "jobId": "string",
- "permitId": "string",
- "planned": {
- "start": "stringst",
- "completion": "stringst",
- "duration": 0,
- "unit": "second"
}, - "actual": {
- "start": "stringst",
- "completion": "stringst",
- "duration": 0,
- "unit": "second"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "trenchId": "f175238a-c421-4dea-a8c0-f696218f3848",
- "poleId": "0a67dabd-85c0-4dcf-a17f-47813de2d7ab"
}, - "coordinate": {
- "x": 0,
- "y": 0,
- "z": 0,
- "m": "string"
}, - "source": "historical",
- "probability": 0,
- "delete": false
}
]| poleId | string <uuid> (poleId) optionally specify the internal pole identifier |
| point required | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| purpose required | string (polePurpose) Enum: "service/drop" "link" "backhaul" "unclassified" intended purpose of the contents carried between (telegraph) poles |
required | object |
required | object |
required | object |
| state | string (poleState) Default: "free" Enum: "free" "used" "reserved" "faulty" state of (telegraph) pole |
object optional site, trench or pole link connection | |
required | object (coordinate) A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
[- {
- "poleId": "0a67dabd-85c0-4dcf-a17f-47813de2d7ab",
- "point": "stringstringstr",
- "country": "ABW",
- "purpose": "service/drop",
- "construction": {
- "height": 0,
- "classifier": "residential",
- "unit": "cm",
- "cost": 0
}, - "demographics": {
- "premises": {
- "passed": 0,
- "area": "residential"
}
}, - "build": {
- "jobId": "string",
- "permitId": "string",
- "planned": {
- "start": "stringst",
- "completion": "stringst",
- "duration": 0,
- "unit": "second"
}, - "actual": {
- "start": "stringst",
- "completion": "stringst",
- "duration": 0,
- "unit": "second"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "trenchId": "f175238a-c421-4dea-a8c0-f696218f3848",
- "poleId": "0a67dabd-85c0-4dcf-a17f-47813de2d7ab"
}, - "coordinate": {
- "x": 0,
- "y": 0,
- "z": 0,
- "m": "string"
}, - "source": "historical",
- "probability": 0,
- "delete": false
}
][- "a9e616ed-1b61-453f-b8f3-95f0449043a8",
- "1e78228c-a6dd-4eed-80c8-bab65c6bcb37",
- "e5f15575-d857-440b-b7a1-8e1b3cb04499",
- "ad1577d0-75aa-41b0-b7b4-c5616e6a216a",
- "f3f27251-c695-4242-861e-582aa2839622",
- "d18b2455-6eee-4cf9-b6e1-6024ab243be3",
- "c43e5fd0-f7cb-4eda-bbcf-e891bc5fddb2",
- "307dc651-eb97-4718-9533-516e34534bfd",
- "b14a3f1f-2124-4590-8885-9f9df8722809",
- "51c1854f-e808-4b5a-9f21-a8c715420a90"
]| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "total": 123,
- "active": 91,
- "inactive": 32
}| from | string = 8 characters ^\d{8}$ range start date format in compressed ISO-8601. (
|
| to | string = 8 characters ^\d{8}$ range end date format in compressed ISO-8601. (
|
| before | string = 8 characters ^\d{8}$ before date format in compressed ISO-8601. (
|
| after | string = 8 characters ^\d{8}$ after date format in compressed ISO-8601. (
|
| aggregate required | string Enum: "day" "week" "month" "quarter" "half-year" "year" unit of measure of the aggregation factor |
{- "by": "month",
- "pole": [
- {
- "poleId": "a9e616ed-1b61-453f-b8f3-95f0449043a8",
- "capacity": [
- {
- "period": "202406",
- "state": "free"
}, - {
- "period": "202407",
- "state": "free"
}, - {
- "period": "202408",
- "state": "used"
}, - {
- "period": "202409",
- "state": "used"
}, - {
- "period": "202403",
- "state": "used"
}, - {
- "period": "202411",
- "state": "used"
}, - {
- "period": "202412",
- "state": "used"
}, - {
- "period": "202501",
- "state": "used"
}
]
}
]
}| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| purpose required | string (polePurpose) Enum: "service/drop" "link" "backhaul" "unclassified" intended purpose of the contents carried between (telegraph) poles |
required | object |
required | object |
required | object |
| state | string (poleState) Default: "free" Enum: "free" "used" "reserved" "faulty" state of (telegraph) pole |
object optional site, trench or pole link connection | |
required | object (coordinate) A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:
|
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "country": "GBR",
- "purpose": "backhaul",
- "construction": {
- "height": 15,
- "unit": "m",
- "classifier": "rural"
}, - "demographics": {
- "premises": {
- "passed": 16,
- "area": "rural"
}
}, - "build": {
- "jobId": "2136",
- "permitId": "RB2020/7833",
- "planned": {
- "start": "20240305",
- "completion": "20240831",
- "duration": 60,
- "unit": "day"
}, - "actual": {
- "start": "20240305",
- "completion": "20240831",
- "duration": 60,
- "unit": "day"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}, - "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{- "poleId": "a9e616ed-1b61-453f-b8f3-95f0449043a8"
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- "a9e616ed-1b61-453f-b8f3-95f0449043a8",
- "1e78228c-a6dd-4eed-80c8-bab65c6bcb37",
- "e5f15575-d857-440b-b7a1-8e1b3cb04499",
- "ad1577d0-75aa-41b0-b7b4-c5616e6a216a",
- "f3f27251-c695-4242-861e-582aa2839622",
- "d18b2455-6eee-4cf9-b6e1-6024ab243be3",
- "c43e5fd0-f7cb-4eda-bbcf-e891bc5fddb2",
- "307dc651-eb97-4718-9533-516e34534bfd",
- "b14a3f1f-2124-4590-8885-9f9df8722809",
- "51c1854f-e808-4b5a-9f21-a8c715420a90"
]| poleId required | string <uuid> internal (telegraph) pole identifier |
| predicted | null Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only |
| restore | null Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged |
{ }| poleId required | string <uuid> internal (telegraph) pole identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| purpose | string (polePurpose) Enum: "service/drop" "link" "backhaul" "unclassified" intended purpose of the contents carried between (telegraph) poles |
required | object |
required | object |
required | object |
| state | string (poleState) Default: "free" Enum: "free" "used" "reserved" "faulty" state of (telegraph) pole |
object optional site, trench or pole link connection | |
required | object (coordinate) A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:
|
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "country": "GBR",
- "purpose": "backhaul",
- "construction": {
- "height": 15,
- "unit": "m",
- "classifier": "rural"
}, - "demographics": {
- "premises": {
- "passed": 16,
- "area": "rural"
}
}, - "build": {
- "jobId": "2136",
- "permitId": "RB2020/7833",
- "planned": {
- "start": "20240305",
- "completion": "20240831",
- "duration": 60,
- "unit": "day"
}, - "actual": {
- "start": "20240305",
- "completion": "20240831",
- "duration": 60,
- "unit": "day"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}, - "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| poleId required | string <uuid> internal (telegraph) pole identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| purpose | string (polePurpose) Enum: "service/drop" "link" "backhaul" "unclassified" intended purpose of the contents carried between (telegraph) poles |
object | |
object | |
object | |
| state | string (poleState) Enum: "free" "used" "reserved" "faulty" state of (telegraph) pole |
object optional site, trench or pole link connection | |
object (coordinate) A geometry is represented using geometric constructs either defined as lists of one or more XY or XYZ points or defined parametrically, for example, as a circular arc. While geometry typically is two- or three-dimensional, it may also contain the measurement dimension (M) to provide the basis for dynamic segments. note:
| |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}
}{ }| poleId required | string <uuid> internal (telegraph) pole identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "poleId": "a9e616ed-1b61-453f-b8f3-95f0449043a8",
- "country": "GBR",
- "purpose": "backhaul",
- "construction": {
- "height": 15,
- "unit": "m"
}, - "demographics": {
- "premises": {
- "passed": 16,
- "area": "rural"
}
}, - "build": {
- "jobId": "2136",
- "permitId": "RB2020/7833",
- "planned": {
- "start": "20240305",
- "completion": "20240831",
- "duration": 60,
- "unit": "day"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}, - "coordinate": {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - "source": "historical",
- "probability": 1,
- "delete": false
}| poleId required | string <uuid> internal (telegraph) pole identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "predicted",
- "probability": 0.25
}
][- {
- "trenchId": "f175238a-c421-4dea-a8c0-f696218f3848",
- "point": "stringstringstr",
- "reference": "string",
- "purpose": "backhaul",
- "construction": {
- "depth": 0,
- "classifier": "low",
- "unit": "cm",
- "type": "micro",
- "cost": 0
}, - "demographics": {
- "premises": {
- "passed": 0,
- "area": "residential"
}
}, - "build": {
- "jobId": "string",
- "permitId": "string",
- "planned": {
- "start": "stringst",
- "completion": "stringst",
- "duration": 0,
- "unit": "second"
}, - "actual": {
- "start": "stringst",
- "completion": "stringst",
- "duration": 0,
- "unit": "second"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "trenchId": "f175238a-c421-4dea-a8c0-f696218f3848",
- "poleId": "0a67dabd-85c0-4dcf-a17f-47813de2d7ab"
}, - "coordinates": [
- {
- "x": 0,
- "y": 0,
- "z": 0,
- "m": "string"
}
], - "source": "historical",
- "probability": 0,
- "delete": false
}
]| trenchId | string <uuid> (trenchId) optionally specify the internal trench identifier |
| point required | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| purpose required | string (trenchPurpose) Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified" intended purpose of the contents of the trench |
| reference required | string |
required | object |
required | object |
required | object |
| state | string (trenchState) Default: "free" Enum: "free" "used" "reserved" "faulty" state of trench |
object optional site, trench or pole link connection | |
required | Array of objects (coordinate) non-empty |
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
[- {
- "trenchId": "f175238a-c421-4dea-a8c0-f696218f3848",
- "point": "stringstringstr",
- "country": "ABW",
- "purpose": "backhaul",
- "reference": "string",
- "construction": {
- "depth": 0,
- "classifier": "low",
- "unit": "cm",
- "type": "micro",
- "cost": 0
}, - "demographics": {
- "premises": {
- "passed": 0,
- "area": "residential"
}
}, - "build": {
- "jobId": "string",
- "permitId": "string",
- "planned": {
- "start": "stringst",
- "completion": "stringst",
- "duration": 0,
- "unit": "second"
}, - "actual": {
- "start": "stringst",
- "completion": "stringst",
- "duration": 0,
- "unit": "second"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "trenchId": "f175238a-c421-4dea-a8c0-f696218f3848",
- "poleId": "0a67dabd-85c0-4dcf-a17f-47813de2d7ab"
}, - "coordinates": [
- {
- "x": 0,
- "y": 0,
- "z": 0,
- "m": "string"
}
], - "source": "historical",
- "probability": 0,
- "delete": false
}
]{ }| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "total": 123,
- "active": 91,
- "inactive": 32
}| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| purpose required | string (trenchPurpose) Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified" intended purpose of the contents of the trench |
| reference required | string |
required | object |
required | object |
required | object |
| state | string (trenchState) Default: "free" Enum: "free" "used" "reserved" "faulty" state of trench |
object optional site, trench or pole link connection | |
required | Array of objects (coordinate) non-empty |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "country": "GBR",
- "purpose": "service/drop",
- "reference": "gbr-worc-cg-south",
- "construction": {
- "depth": 0.5,
- "classifier": "low",
- "unit": "m",
- "type": "micro",
- "cost": 2000
}, - "demographics": {
- "premises": {
- "passed": 4,
- "area": "residential"
}
}, - "build": {
- "jobId": "2148",
- "permitId": "RB2021/1492",
- "planned": {
- "start": "20241005",
- "completion": "20241008",
- "duration": 3,
- "unit": "day"
}, - "actual": {
- "start": "20241005",
- "completion": "20241008",
- "duration": 3,
- "unit": "day"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}, - "coordinates": [
- {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09448,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09448,
- "z": 2357
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}{- "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d"
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
| country | string Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" optional filter of resource within specified ISO 3166-1 alpha-3 three-letter country code
|
[- "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
- "30f8afcd-f95d-4686-a7cf-7543911e3916",
- "b091c215-68a4-4d53-bed0-fb70bf808ea3",
- "6722383f-2dff-439a-8831-59fb491f143d",
- "e276c320-df70-420d-841e-8cf9c7f0d731",
- "1256dc14-6935-4848-9872-2d97abd777bf",
- "791b0ccb-308b-44b9-ba9c-2f92b26015ac",
- "68558a89-5b37-4c90-910d-876e1fffc19f",
- "96f4b334-1647-48e6-99ec-4135247c3210",
- "9bcd04c1-a307-4518-81ae-8c51a2e6bb5a"
]| trenchId required | string <uuid> internal trench identifier |
| predicted | null Flag parameter used to determine to optionally limit the deletion to generated (predicted) variants only |
| restore | null Flag parameter used to restore (undelete) specified historical resource if had previously existed but was deleted, note: this only applies to historical records that have not been expunged |
{ }| trenchId required | string <uuid> internal trench identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| purpose | string (trenchPurpose) Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified" intended purpose of the contents of the trench |
| reference required | string |
required | object |
required | object |
required | object |
| state | string (trenchState) Default: "free" Enum: "free" "used" "reserved" "faulty" state of trench |
object optional site, trench or pole link connection | |
required | Array of objects (coordinate) non-empty |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "country": "GBR",
- "purpose": "service/drop",
- "reference": "gbr-worc-cg-south",
- "construction": {
- "depth": 0.5,
- "classifier": "low",
- "unit": "m",
- "type": "micro",
- "cost": 2500
}, - "demographics": {
- "premises": {
- "passed": 4,
- "area": "residential"
}
}, - "build": {
- "jobId": "2148",
- "permitId": "RB2021/1492",
- "planned": {
- "start": "20241005",
- "completion": "20241008",
- "duration": 3,
- "unit": "day"
}, - "actual": {
- "start": "20241005",
- "completion": "20241008",
- "duration": 3,
- "unit": "day"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}, - "coordinates": [
- {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09448,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09448,
- "z": 2357
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}{ }| trenchId required | string <uuid> internal trench identifier |
| country | any (countryCode) Enum: "ABW" "AFG" "AGO" "AIA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BWA" "CAF" "CAN" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SHN" "SLB" "SLE" "SLV" "SMR" "SOM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" ISO 3166-1 alpha-3 three-letter country codes
|
| purpose | string (trenchPurpose) Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified" intended purpose of the contents of the trench |
| reference | string |
object | |
object | |
object | |
| state | string (trenchState) Enum: "free" "used" "reserved" "faulty" state of trench |
object optional site, trench or pole link connection | |
Array of objects (coordinate) non-empty | |
| point | string (dateTime) = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| delete | boolean (delete) MNI internal metadata field to indicate record is marked for deletion |
{- "coordinates": [
- {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09448,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}
]
}{ }| trenchId required | string <uuid> internal trench identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "trenchId": "5ef82c6f-b06b-4d93-a4c2-3b78b62dd7cf",
- "reference": "gbr-worc-cg-south",
- "country": "GBR",
- "purpose": "service/drop",
- "construction": {
- "depth": 0.5,
- "depthClassifier": "low",
- "unit": "m",
- "type": "micro",
- "cost": 2500
}, - "demographics": {
- "premises": {
- "passed": 4,
- "area": "residential"
}
}, - "build": {
- "jobId": "2148",
- "permitId": "RB2021/1492",
- "planned": {
- "start": "20241005",
- "completion": "20241008",
- "duration": 3,
- "unit": "day"
}
}, - "state": "free",
- "connectsTo": {
- "siteId": "86e420f1-137b-4e34-9ff7-18bd12743a10"
}, - "coordinates": [
- {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26455,
- "y": 36.09448,
- "z": 2357
}, - {
- "x": -112.26456,
- "y": 36.12448,
- "z": 2357
}, - {
- "x": -112.26457,
- "y": 36.14448,
- "z": 2357
}, - {
- "x": -112.26458,
- "y": 36.15448,
- "z": 2357
}, - {
- "x": -112.26459,
- "y": 36.17448,
- "z": 2357
}, - {
- "x": -112.2646,
- "y": 36.19448,
- "z": 2357
}, - {
- "x": -112.26451,
- "y": 36.21448,
- "z": 2357
}
], - "source": "historical",
- "probability": 1,
- "delete": false
}| trenchId required | string <uuid> internal trench identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "distance": 0.014618,
- "unit": "m"
}| from | string = 8 characters ^\d{8}$ range start date format in compressed ISO-8601. (
|
| to | string = 8 characters ^\d{8}$ range end date format in compressed ISO-8601. (
|
| before | string = 8 characters ^\d{8}$ before date format in compressed ISO-8601. (
|
| after | string = 8 characters ^\d{8}$ after date format in compressed ISO-8601. (
|
| aggregate required | string Enum: "day" "week" "month" "quarter" "half-year" "year" unit of measure of the aggregation factor |
{- "by": "month",
- "trench": [
- {
- "trenchId": "38b6c897-9982-4426-b9e3-c603e7e2cb5d",
- "capacity": [
- {
- "period": "202406",
- "state": "free"
}, - {
- "period": "202407",
- "state": "free"
}, - {
- "period": "202408",
- "state": "used"
}, - {
- "period": "202409",
- "state": "used"
}, - {
- "period": "202410",
- "state": "used"
}, - {
- "period": "202411",
- "state": "used"
}, - {
- "period": "202412",
- "state": "used"
}, - {
- "period": "202501",
- "state": "used"
}
]
}
]
}| trenchId required | string <uuid> internal trench identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "predicted",
- "probability": 0.25
}
]| trenchId required | string <uuid> internal trench identifier |
{- "20250228T000000": [
- {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09547,
- "z": 2357
}
], - "20250302T000000": [
- {
- "x": -112.26454,
- "y": 36.09648,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09748,
- "z": 2357
}
], - "20250402T000000": [
- {
- "x": -112.26454,
- "y": 36.09951,
- "z": 2357
}
], - "sets": [
- {
- "point": "20250228T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250302T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250402T000000",
- "source": "predicted",
- "probability": 0.25
}
]
}| trenchId required | string <uuid> internal trench identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
[- {
- "x": -112.26454,
- "y": 36.09447,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09547,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09648,
- "z": 2357
}, - {
- "x": -112.26454,
- "y": 36.09748,
- "z": 2357
}
]| trenchId required | string <uuid> internal trench identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{- "passed": 20
}| purpose required | string (trenchPurpose) Enum: "backhaul" "pole" "ring" "service/drop" "tower" "unclassified" intended purpose of the contents of the trench |
| type | string (constructionType) Enum: "micro" "narrow" "backhoe" "inline" "portable" "large" type of trench construction |
| trenchId | string <uuid> (trenchId) internal trench identifier |
| isoCode | string (currencyIsoCode) Default: "EUR" Enum: "AUD" "BND" "CHF" "CLP" "DKK" "EUR" "FKP" "GBP" "INR" "NOK" "NZD" "RUB" "SGD" "SHP" "TRY" "USD" "XAF" "XCD" "XCG" "XOF" "XPF" "ZAR" ISO code for currency |
required | Array of objects (coordinate) >= 2 items |
{- "purpose": "service/drop",
- "trenchId": "b55fcbef-6d4f-4803-8755-0d920835de85",
- "isoCode": "EUR",
- "coordinates": [
- {
- "x": 52.314930723981576,
- "y": -2.1765905793762297
}, - {
- "x": 52.31530785113297,
- "y": -2.175979035720834
}, - {
- "x": 52.315461980435,
- "y": -2.175683992729196
}, - {
- "x": 52.31558987455477,
- "y": -2.1755713399505705
}, - {
- "x": 52.3157144889826,
- "y": -2.1754694160080046
}, - {
- "x": 52.315793192650986,
- "y": -2.1754533227539152
}
]
}{- "cost": 3.75,
- "distance": 3.75,
- "unit": "m",
- "symbol": "€",
- "isoCode": "EUR",
- "rate": 1
}required | object |
required | object |
{- "historical": {
- "duration": 0,
- "unit": "second"
}, - "predicted": {
- "duration": 0,
- "unit": "second"
}
}{ }| duration required | integer >= 1 |
| unit required | string (durationUnit) Enum: "second" "minute" "hour" "day" "week" "month" "quarter" "year" unit of measure of the duration |
{- "duration": 6,
- "unit": "month"
}{ }| period required | integer >= 1 |
| unit required | string (durationUnit) Enum: "second" "minute" "hour" "day" "week" "month" "quarter" "year" unit of measure of the duration |
{- "period": 3,
- "unit": "week"
}{ }[- {
- "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad",
- "vendor": "FastMail",
- "address": "ni@marlindt.net",
- "name": "MarlinDT Network Intelligence",
- "send": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "smtp.fastmail.com",
- "port": 465,
- "protocol": "smtp",
- "authentication": "PLAIN",
- "encryption": {
- "enabled": true,
- "starttls": false
}
}
}
]| emailProviderId required | string <uuid> (emailProviderId) optionally specify the internal email provider identifier |
| vendor required | string vendor name |
| address required | string <uri> email address |
| name required | any <string> email address name |
required | object (emailSend) outbound host, credentials and protocol used to send email |
object (emailReceive) inbound host, credentials and protocol used to receive email |
[- {
- "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad",
- "vendor": "FastMail",
- "address": "ni@marlindt.net",
- "name": "MarlinDT Network Intelligence",
- "send": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "smtp.fastmail.com",
- "port": 465,
- "protocol": "smtp",
- "authentication": "PLAIN",
- "encryption": {
- "enabled": true,
- "starttls": false
}
}
}
]{ }| vendor required | string vendor name |
| address required | string <email> email address |
| name | any <string> email address name |
required | object (emailSend) outbound host, credentials and protocol used to send email |
object (emailReceive) inbound host, credentials and protocol used to receive email |
{- "vendor": "FastMail",
- "address": "ni@marlindt.net",
- "name": "MarlinDT Network Intelligence",
- "send": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "smtp.fastmail.com",
- "port": 465,
- "protocol": "smtp",
- "authentication": "PLAIN",
- "encryption": {
- "enabled": true,
- "starttls": false
}
}, - "receive": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "imap.fastmail.com",
- "port": 993,
- "protocol": "imap4",
- "encryption": {
- "enabled": true,
- "starttls": false
}, - "folderSeparator": "/"
}
}{- "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad"
}| emailProviderId required | string <uuid> internal email provider identifier |
{- "emailProviderId": "6eafc385-43a1-4b49-9dd9-902a2a12a4ad",
- "vendor": "FastMail",
- "address": "ni@marlindt.net",
- "name": "MarlinDT Network Intelligence",
- "send": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "smtp.fastmail.com",
- "port": 465,
- "protocol": "smtp",
- "authentication": "PLAIN",
- "encryption": {
- "enabled": true,
- "starttls": false
}
}
}| emailProviderId required | string <uuid> internal email provider identifier |
| vendor | string vendor name |
| address | string <uri> email address |
| name | any <string> email address name |
object (emailSend) outbound host, credentials and protocol used to send email | |
object (emailReceive) inbound host, credentials and protocol used to receive email |
update both IMAP4 and SMTP passwords
{- "send": {
- "password": "password123&#"
}, - "receive": {
- "password": "password123&#"
}
}{ }| emailProviderId required | string <uuid> internal email provider identifier |
| vendor required | string vendor name |
| address required | string <uri> email address |
| name | any <string> email address name |
required | object (emailSend) outbound host, credentials and protocol used to send email |
object (emailReceive) inbound host, credentials and protocol used to receive email |
{- "vendor": "FastMail",
- "address": "ni@marlindt.net",
- "name": "MarlinDT Network Intelligence",
- "send": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "smtp.fastmail.com",
- "port": 465,
- "protocol": "smtp",
- "authentication": "PLAIN",
- "encryption": {
- "enabled": true,
- "starttls": false
}
}
}{ }[- {
- "kafkaProducerId": "5b1ef698-1cf3-4f12-a671-d60ff283db41",
- "name": "west",
- "clientId": "mni",
- "producer": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "10.72.34.16",
- "port": 9092,
- "retryDelay": 10000,
- "retries": 2,
- "acks": "leader",
- "linger": 0,
- "batchSize": 16,
- "bufferMemory": 32,
- "maxInflightRequestsPerConnection": 5,
- "compressionMethod": "none",
- "authentication": "none"
}
}
]| kafkaProducerId | string <uuid> (kafkaProducerId) optionally specify the internal Kafka broker identifier |
| name required | string name of Kafka broker for human purposes |
| clientId required | string Default: "mni" |
required | object (kafkaProducer) outbound host, credentials and protocol used to send stream |
[- {
- "kafkaProducerId": "5b1ef698-1cf3-4f12-a671-d60ff283db41",
- "name": "west",
- "clientId": "mni",
- "producer": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "10.72.34.16",
- "port": 9092,
- "retryDelay": 10000,
- "retries": 2,
- "acks": "leader",
- "linger": 0,
- "batchSize": 16,
- "bufferMemory": 32,
- "maxInflightRequestsPerConnection": 5,
- "compressionMethod": "none",
- "authentication": "none"
}
}
][- "f3fd73b2-f08b-43f5-ad36-54299bf7dfab"
]| name required | string name of Kafka broker for human purposes |
| clientId required | string Default: "mni" |
required | object (kafkaProducer) outbound host, credentials and protocol used to send stream |
{- "name": "west",
- "clientId": "mni",
- "producer": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "10.72.34.16",
- "port": 9092,
- "authentication": "none"
}
}{- "kafkaProducerId": "5b1ef698-1cf3-4f12-a671-d60ff283db41"
}| kafkaProducerId required | string <uuid> internal Kafka broker identifier |
{- "kafkaProducerId": "5b1ef698-1cf3-4f12-a671-d60ff283db41",
- "name": "west",
- "clientId": "mni",
- "producer": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "10.72.34.16",
- "port": 9092,
- "retryDelay": 10000,
- "retries": 2,
- "acks": "leader",
- "linger": 0,
- "batchSize": 16,
- "bufferMemory": 32,
- "maxInflightRequestsPerConnection": 5,
- "compressionMethod": "none",
- "authentication": "none"
}
}| kafkaProducerId required | string <uuid> internal Kafka broker identifier |
| name | string name of Kafka broker for human purposes |
| clientId | string Default: "mni" |
object (kafkaProducer) outbound host, credentials and protocol used to send stream |
{- "producer": {
- "compressionMethod": "gzip"
}
}{ }| kafkaProducerId required | string <uuid> internal Kafka broker identifier |
| name required | string name of Kafka broker for human purposes |
| clientId required | string Default: "mni" |
required | object (kafkaProducer) outbound host, credentials and protocol used to send stream |
{- "name": "west",
- "clientId": "mni",
- "producer": {
- "username": "ni@marlindt.net",
- "password": "password123&#",
- "host": "10.72.34.16",
- "port": 9092,
- "authentication": "basic"
}
}{ }[- {
- "mapProviderId": "09d475ec-96e1-4e9c-848d-06b432df59e7",
- "vendor": "OpenStreet Map",
- "default": false,
- "credentials": {
- "identity": "mni",
- "key": "AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe"
}, - "identityProvider": {
- "authorization": "/oauth2/authorize",
- "token": "/oauth2/token",
- "wellKnown": "/.well-known/oauth-authorization-server"
}
}
]| mapProviderId required | string <uuid> (mapProviderId) optionally specify the internal map provider identifier |
| vendor required | string (mapVendorPlatform) Enum: "OpenStreet Map" "Google Maps" "Microsoft Azure" "ERSI" supported map vendor platforms |
| default | boolean Default: false system-wide default provider |
| renderUrl required | string <url> base URL for map rendering operations |
required | object |
[- {
- "mapProviderId": "09d475ec-96e1-4e9c-848d-06b432df59e7",
- "vendor": "Google Maps",
- "default": false,
- "credentials": {
- "identity": "mni",
- "key": "googleSuppliedKey"
}
}
][- "09d475ec-96e1-4e9c-848d-06b432df59e7"
]| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
[- "9fbb4c17-07fb-4990-ad84-22b8078ae58f",
- "089b8099-dd52-419a-8bc8-b7fd87605bfe",
- "ef48e255-d604-48a4-970a-c3d92fa271e8",
- "a4ace64f-4ddd-4355-a4ea-71ee8e7d7a58",
- "09d475ec-96e1-4e9c-848d-06b432df59e7"
]| vendor required | string (mapVendorPlatform) Enum: "OpenStreet Map" "Google Maps" "Microsoft Azure" "ERSI" supported map vendor platforms |
| default | boolean Default: false system-wide default provider |
| renderUrl required | string <url> base URL for map rendering operations |
required | object |
{- "vendor": "OpenStreet Map",
- "default": false,
- "identityProvider": {
- "authorization": "/oauth2/authorize",
- "token": "/oauth2/token",
- "wellKnown": "/.well-known/oauth-authorization-server"
}
}{- "mapProviderId": "ff9bf3a0-682e-43ff-b38c-0ab962ef2fe7"
}| mapProviderId required | string <uuid> internal map provider identifier |
{- "mapProviderId": "09d475ec-96e1-4e9c-848d-06b432df59e7",
- "vendor": "OpenStreet Map",
- "default": false,
- "identityProvider": {
- "authorization": "/oauth2/authorize",
- "token": "/oauth2/token",
- "wellKnown": "/.well-known/oauth-authorization-server"
}
}| mapProviderId required | string <uuid> internal map provider identifier |
| vendor required | string (mapVendorPlatform) Enum: "OpenStreet Map" "Google Maps" "Microsoft Azure" "ERSI" supported map vendor platforms |
| default | boolean Default: false system-wide default provider |
| renderUrl required | string <url> base URL for map rendering operations |
required | object |
{- "vendor": "OpenStreet Map",
- "default": false,
- "identityProvider": {
- "authorization": "/oauth2/authorize",
- "token": "/oauth2/token",
- "wellKnown": "/.well-known/oauth-authorization-server"
}
}{ }| mapProviderId required | string <uuid> internal map provider identifier |
| vendor | string (mapVendorPlatform) Enum: "OpenStreet Map" "Google Maps" "Microsoft Azure" "ERSI" supported map vendor platforms |
| default | boolean Default: false system-wide default provider |
| renderUrl | string <url> base URL for map rendering operations |
object |
{- "default": true,
- "credentials": {
- "key": "googleSuppliedKey"
}
}{ }[- {
- "workflowEngineId": "f069bd6c-e663-4c0c-a273-17840c1e8263",
- "name": "camunda8",
- "engine": {
- "username": "internal",
- "password": "service",
- "type": "bpmn"
}
}
]| workflowEngineId | string <uuid> (workflowEngineId) optionally specify the internal workflow engine identifier |
| source | string (source) Enum: "historical" "planned" "predicted" MNI internal metadata field used to determine if value was supplied or generated via machine learning predictive algorithms
|
| probability | number <float> (probability) [ 0 .. 1 ] Is a measure of the likelihood that an resource will occur as described.
It's a value between
|
| name required | string name of workflow engine for human purposes |
required | object (workflowEngine) workflow engine host, credentials etc. |
[- {
- "workflowEngineId": "f069bd6c-e663-4c0c-a273-17840c1e8263",
- "name": "camunda8",
- "engine": {
- "username": "internal",
- "password": "service",
- "type": "bpmn"
}
}
][- "f069bd6c-e663-4c0c-a273-17840c1e8263"
]| name required | string name of workflow engine for human purposes |
required | object (workflowEngine) workflow engine host, credentials etc. |
{- "name": "camunda8",
- "engine": {
- "username": "internal",
- "password": "service",
- "type": "elsa"
}
}{- "workflowEngineId": "f069bd6c-e663-4c0c-a273-17840c1e8263"
}| workflowEngineId required | string <uuid> unique identifier of the workflow engine |
{- "workflowEngineId": "f069bd6c-e663-4c0c-a273-17840c1e8263",
- "name": "camunda8",
- "engine": {
- "username": "internal",
- "password": "service",
- "type": "bpmn"
}
}| workflowEngineId required | string <uuid> unique identifier of the workflow engine |
| name | string name of workflow engine for human purposes |
object (workflowEngine) workflow engine host, credentials etc. |
{- "engine": {
- "type": "bpmn"
}
}{ }| workflowEngineId required | string <uuid> unique identifier of the workflow engine |
| name required | string name of workflow engine for human purposes |
required | object (workflowEngine) workflow engine host, credentials etc. |
{- "name": "camunda",
- "engine": {
- "username": "internal",
- "password": "service",
- "type": "bpmn"
}
}{ }{- "cable": {
- "cableId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "duct": {
- "ductId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "ne": {
- "neId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "pole": {
- "poleId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "rack": {
- "rackId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "service": {
- "serviceId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "site": {
- "siteId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "trench": {
- "trenchId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20240918T150800",
- "20241019T150800",
- "20241206T150800"
]
}
}{- "cable": {
- "cableId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "duct": {
- "ductId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "ne": {
- "neId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "pole": {
- "poleId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "rack": {
- "rackId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "service": {
- "serviceId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "site": {
- "siteId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20241118T150800"
]
}, - "trench": {
- "trenchId": "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "point": [
- "20240918T150800",
- "20241019T150800",
- "20241206T150800"
]
}
}| regex | null Flag parameter used to indicate the supplied search phrase should be treated as a Regular Expression (RegEx), note: the
|
| resource required | string (searchResourceType) Enum: "adminEmail" "adminKafka" "adminMap" "adminWorkflow" "alert" "cable" "currency" "cve" "document" "duct" "ne" "pole" "rack" "service" "site" "trench" "*" internal MNI resource type to search, note: |
| query required | string case insensitive query phrase specified with search, note: wildcards can also be included:
|
{- "resource": "*",
- "query": "sample"
}{- "results": [
- {
- "resource": "service",
- "id": "81eefb1f-57d4-40be-bfa9-c765e6d7577a"
}, - {
- "resource": "service",
- "id": "784d5d3d-44cf-41a2-8ef0-24a376b0b296"
}
], - "found": 2,
- "resource": "*",
- "query": "sample"
}| scope required | string (secretScope) scope identifier of the authorization credential |
| realm required | string (secretRealm) realm identifier of the authorization credential |
| type required | string (secretType) Enum: "identity" "plain" "snmp" "ssh" "ssl" "token" type of the authorization credential that is to be managed, note:
|
required | object (secretIdentity) OpenID/OAuth style credential |
object (secretPlain) Plain username/password style credential | |
secretSnmpV1V2c (object) or secretSnmpV3 (object) | |
object (secretSsh) SSH style credential with optional host certificate authority (CA) | |
object (secretSsl) SSL style credential | |
object (secretToken) RESTful API style token credential |
{- "scope": "example",
- "realm": "edge01gw",
- "type": "plain",
- "plain": {
- "username": "admin",
- "password": "admin",
- "expiration": "20251231T235959"
}
}{ }| scope required | string scope identifier of the authorization credential |
| realm required | string realm identifier of the authorization credential |
| type required | string Enum: "identity" "plain" "snmp" "ssh" "ssl" "token" type of the authorization credential that is to be managed, note:
|
{- "scope": "example",
- "realm": "edge01gw",
- "type": "plain",
- "plain": {
- "username": "admin",
- "password": "admin",
- "expiration": "20251231T235959"
}
}| scope required | string scope identifier of the authorization credential |
| realm required | string realm identifier of the authorization credential |
| type required | string Enum: "identity" "plain" "snmp" "ssh" "ssl" "token" type of the authorization credential that is to be managed, note:
|
{ }| document | string document filename that is being uploaded |
| form-content | string <binary> |
{- "documentId": "d94641c3-4507-4589-882e-3d31621b3a0e",
- "hash": "c96970e2220bf6385edc6b56d9682e4a",
- "size": 4286,
- "mimeType": "image/vnd.microsoft.icon"
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
[- "5520aca1-4727-431a-aa9c-23f2e54b8a41",
- "df4600ba-c46f-428a-855d-eb84caf9b59c"
]| documentId required | string <uuid> internal document identifier |
| point | string = 15 characters ^\d{8}T\d{6}$ MNI date format in compressed ISO-8601. (
|
{ }| documentId required | string <uuid> internal document identifier |
| document | string document filename that is being uploaded |
| form-content | string <binary> |
{- "documentId": "d94641c3-4507-4589-882e-3d31621b3a0e",
- "hash": "c96970e2220bf6385edc6b56d9682e4a",
- "size": 5145,
- "mimeType": "image/vnd.microsoft.icon"
}| documentId required | string <uuid> internal document identifier |
[- {
- "point": "20250102T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250118T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250202T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20250309T000000",
- "source": "historical",
- "probability": 1
}, - {
- "point": "20260401T000000",
- "source": "planned",
- "probability": 0.5
}
]| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
[- "747ded39-4273-423b-8550-d2009f2d6575",
- "4810b82c-961f-4949-92f7-550ceaff594b",
- "2bbe3d5b-6975-45f4-a6ed-f1b67f990240"
]required | object |
required | object |
| type required | string (correlationType) Enum: "cable" "duct" "ne" "other" "pole" "rack" "service" "site" "trench" "unknown" intended related resource of correlation |
| fetchJobId required | string <uuid> (fetchId) internal fetch job identifier |
{- "source": {
- "object": "ROUTE_TB",
- "reference": "id",
- "value": "12"
}, - "destination": {
- "object": "trench",
- "reference": "trenchId",
- "value": "8fc1b88c-ab92-42e8-b95a-8453c401fb0f"
}, - "type": "trench",
- "fetchJobId": "4810b82c-961f-4949-92f7-550ceaff594b"
}{- "correlationId": "2e50d7ff-7e3a-479b-b45e-3e20146967af"
}| correlationId required | string <uuid> internal fetch correlation identifier |
{- "source": {
- "object": "ROUTE_TB",
- "reference": "id",
- "value": "14"
}, - "destination": {
- "object": "trench",
- "reference": "trenchId",
- "value": "8fc1b88c-ab92-42e8-b95a-8453c401fb0f"
}, - "type": "trench",
- "fetchJobId": "4810b82c-961f-4949-92f7-550ceaff594b"
}| pageSize | integer [ 8 .. 128 ] pagination page size |
| pageNumber | integer >= 1 pagination page number |
[- "747ded39-4273-423b-8550-d2009f2d6575",
- "4810b82c-961f-4949-92f7-550ceaff594b",
- "2bbe3d5b-6975-45f4-a6ed-f1b67f990240"
]| fetchId required | string <uuid> internal fetch job identifier |
{ }{ }Find the matching ISO 3166-1 alpha-3 three-letter country code that contains the supplied coordinate
| x required | number <float> [ -180 .. 180 ] Default: 0 measured along east-west axis |
| y required | number <float> [ -90 .. 90 ] Default: 0 measured along north-south axis |
| z | number <float> Default: 0 measured height or elevation |
| m | string extra axis of information not associated with the cartesian x/y/z space |
{- "x": -4.43205199969999,
- "y": 57.4943539998374
}{- "country": "GBR"
}